Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minor Improvements to Documentation Guide #1691

Merged
merged 1 commit into from
Oct 14, 2024
Merged

Minor Improvements to Documentation Guide #1691

merged 1 commit into from
Oct 14, 2024

Conversation

Mefisto04
Copy link
Contributor

This pull request introduces minor enhancements to the documentation guide, focusing on clarity and consistency. The following changes have been made:

  • Clarified instructions for building HTML documentation with sphinx.
  • Improved formatting for better readability in command descriptions.
  • Modified wording for smoother flow and consistency.
  • Updated bullet points to maintain a uniform style.
  • Enhanced example descriptions for better understanding.

These changes aim to improve the overall quality of the documentation without introducing major alterations.

philippmwirth
philippmwirth approved these changes Oct 14, 2024
View reviewed changes
Copy link
Contributor

@philippmwirth philippmwirth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot!

@codecov Codecov
Copy link

codecov bot commented Oct 14, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.78%. Comparing base (56e669a) to head (cef8007).
Report is 1 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #1691   +/-   ##
=======================================
  Coverage   84.78%   84.78%           
=======================================
  Files         154      154           
  Lines        6479     6479           
=======================================
  Hits         5493     5493           
  Misses        986      986

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Mefisto04
Copy link
Contributor Author

@philippmwirth please merge this changes

@philippmwirth philippmwirth merged commit b8613dc into lightly-ai:master Oct 14, 2024
14 checks passed
payo101 pushed a commit to payo101/lightly that referenced this pull request Oct 20, 2024
@Mefisto04 @payo101
Update README.md (lightly-ai#1691)
cf24dfa
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@philippmwirth philippmwirth philippmwirth approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Mefisto04 @philippmwirth